Support transport action names when registering NamedRoutes by DarshitChanpura · Pull Request #7957 · opensearch-project/OpenSearch

DarshitChanpura · 2023-06-07T17:26:03Z

Description

This change allows plugin devs to register a named route to be mapped against existing transport action name by passing a legacy name when registering a NamedRoute.

Related to: opensearch-project/security#2752

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Commits are signed per the DCO using --signoff
Commit changes are listed out in CHANGELOG.md file (See: Changelog)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

cwperks

Thanks @DarshitChanpura, I left some minor comments but otherwise this looks good to me.

server/src/main/java/org/opensearch/action/ActionModule.java

server/src/main/java/org/opensearch/rest/NamedRoute.java

server/src/test/java/org/opensearch/action/DynamicActionRegistryTests.java

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

github-actions · 2023-06-07T17:57:54Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/17049/
CommitID: 8087f6a
Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
Is the failure a flaky test unrelated to your change?

server/src/main/java/org/opensearch/rest/NamedRoute.java

github-actions · 2023-06-07T18:20:21Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/17055/
CommitID: d8c3abf
Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
Is the failure a flaky test unrelated to your change?

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

github-actions · 2023-06-07T19:14:07Z

Gradle Check (Jenkins) Run Completed with:

RESULT: null ❌
URL: https://build.ci.opensearch.org/job/gradle-check/17064/
CommitID: 66b3f88
Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
Is the failure a flaky test unrelated to your change?

github-actions · 2023-06-07T19:41:50Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/17066/
CommitID: 98564f9
Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
Is the failure a flaky test unrelated to your change?

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

github-actions · 2023-06-07T23:40:26Z

Gradle Check (Jenkins) Run Completed with:

RESULT: null ❌
URL: null
CommitID: bff1a58
Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
Is the failure a flaky test unrelated to your change?

github-actions · 2023-06-08T00:10:16Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/17085/
CommitID: 411c12a
Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
Is the failure a flaky test unrelated to your change?

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

github-actions · 2023-06-08T00:58:07Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/17087/
CommitID: 655da5e
Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
Is the failure a flaky test unrelated to your change?

server/src/main/java/org/opensearch/rest/NamedRoute.java

server/src/main/java/org/opensearch/rest/extensions/RestSendToExtensionAction.java

…ring a named route Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

server/src/main/java/org/opensearch/rest/NamedRoute.java

github-actions · 2023-06-13T15:33:24Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/17457/
CommitID: 97f1383
Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green.
Is the failure a flaky test unrelated to your change?

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

github-actions · 2023-07-05T16:33:56Z

Gradle Check (Jenkins) Run Completed with:

RESULT: UNSTABLE ❕
TEST FAILURES:

      1 org.opensearch.remotestore.SegmentReplicationUsingRemoteStoreIT.testNodeDropWithOngoingReplication

URL: https://build.ci.opensearch.org/job/gradle-check/19154/
CommitID: 0da4388
Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

github-actions · 2023-07-05T17:06:36Z

Gradle Check (Jenkins) Run Completed with:

RESULT: UNSTABLE ❕
TEST FAILURES:

      1 org.opensearch.remotestore.SegmentReplicationUsingRemoteStoreIT.testNodeDropWithOngoingReplication
      1 org.opensearch.indices.replication.SegmentReplicationIT.testCancellation

URL: https://build.ci.opensearch.org/job/gradle-check/19159/
CommitID: cb9ad3d
Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

dbwiddis

Looks great, just two final requests.

server/src/main/java/org/opensearch/action/ActionModule.java

server/src/main/java/org/opensearch/rest/NamedRoute.java

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

dbwiddis

LGTM! Great work.

github-actions · 2023-07-05T18:55:11Z

Gradle Check (Jenkins) Run Completed with:

RESULT: UNSTABLE ❕
TEST FAILURES:

      1 org.opensearch.remotestore.SegmentReplicationUsingRemoteStoreIT.testNodeDropWithOngoingReplication
      1 org.opensearch.remotestore.SegmentReplicationRemoteStoreIT.testReplicationAfterForceMerge

URL: https://build.ci.opensearch.org/job/gradle-check/19166/
CommitID: aac062a
Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

DarshitChanpura · 2023-07-05T21:45:53Z

@peternied Would you please merge this?

opensearch-trigger-bot · 2023-07-05T21:57:00Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-7957-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 50d8006d5ffb72566b893ef23748d48b26c3a65e
# Push it to GitHub
git push --set-upstream origin backport/backport-7957-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-7957-to-2.x.

…ch-project#7957) * Adds ability to register legacy action names along with route Signed-off-by: Darshit Chanpura <dchanp@amazon.com> Signed-off-by: Darshit Chanpura <35282393+DarshitChanpura@users.noreply.github.com> (cherry picked from commit 50d8006)

…outes (#7957) (#8459) * Support transport action names when registering NamedRoutes (#7957) * Adds ability to register legacy action names along with route Signed-off-by: Darshit Chanpura <dchanp@amazon.com> Signed-off-by: Darshit Chanpura <35282393+DarshitChanpura@users.noreply.github.com> (cherry picked from commit 50d8006) * Fixes Changelog entry Signed-off-by: Darshit Chanpura <dchanp@amazon.com> --------- Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

…g NamedRoutes (opensearch-project#7957) (opensearch-project#8459)" This reverts commit cd82f4c.

…g NamedRoutes (opensearch-project#7957) (opensearch-project#8459)" This reverts commit cd82f4c. Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

…g NamedRoutes (opensearch-project#7957) (opensearch-project#8459)" This reverts commit cd82f4c.

…g NamedRoutes (opensearch-project#7957) (opensearch-project#8459)" This reverts commit cd82f4c. Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

* Adds ability to register legacy action names along with route Signed-off-by: Darshit Chanpura <dchanp@amazon.com> Signed-off-by: Darshit Chanpura <35282393+DarshitChanpura@users.noreply.github.com>

…g NamedRoutes (#7957) (#8459)" (#8651) This reverts commit cd82f4c. Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

…ch-project#7957) * Adds ability to register legacy action names along with route Signed-off-by: Darshit Chanpura <dchanp@amazon.com> Signed-off-by: Darshit Chanpura <35282393+DarshitChanpura@users.noreply.github.com> Signed-off-by: sahil buddharaju <sahilbud@amazon.com>

…ch-project#7957) * Adds ability to register legacy action names along with route Signed-off-by: Darshit Chanpura <dchanp@amazon.com> Signed-off-by: Darshit Chanpura <35282393+DarshitChanpura@users.noreply.github.com>

…ch-project#7957) * Adds ability to register legacy action names along with route Signed-off-by: Darshit Chanpura <dchanp@amazon.com> Signed-off-by: Darshit Chanpura <35282393+DarshitChanpura@users.noreply.github.com> Signed-off-by: Shivansh Arora <hishiv@amazon.com>

DarshitChanpura and others added 3 commits June 7, 2023 13:22

Adds ability to register legacy action names along with route

5603475

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

Adds tests to cover legacy action name registration

8fee10c

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

Merge branch 'opensearch-project:main' into legacy-action-names

8087f6a

DarshitChanpura changed the title ~~Supporting legacy action names when registering NamedRoutes~~ Support legacy action names when registering NamedRoutes Jun 7, 2023

Adds this PR to CHANGELOG

3cd35e4

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

cwperks approved these changes Jun 7, 2023

View reviewed changes

server/src/main/java/org/opensearch/action/ActionModule.java Outdated Show resolved Hide resolved

server/src/main/java/org/opensearch/rest/NamedRoute.java Outdated Show resolved Hide resolved

server/src/test/java/org/opensearch/action/DynamicActionRegistryTests.java Show resolved Hide resolved

Adds javadoc and addresses PR comments

d8c3abf

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

DarshitChanpura force-pushed the legacy-action-names branch 3 times, most recently from 21903da to 8773509 Compare June 7, 2023 18:11

cwperks reviewed Jun 7, 2023

View reviewed changes

server/src/main/java/org/opensearch/rest/NamedRoute.java Outdated Show resolved Hide resolved

DarshitChanpura added 2 commits June 7, 2023 15:07

Renames getter to match variable name

66b3f88

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

Fix spotless errors

98564f9

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

Makes legacyActionName an optional nullable reference

411c12a

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

DarshitChanpura force-pushed the legacy-action-names branch from bff1a58 to 411c12a Compare June 7, 2023 23:40

Unregisters action name upon route unregister call

655da5e

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

peternied reviewed Jun 9, 2023

View reviewed changes

DarshitChanpura added 3 commits June 13, 2023 11:04

Adds support for mapping multiple transport action names when registe…

31e9f5e

…ring a named route Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

Updates tests

a9ab347

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

Merge branch 'main' into legacy-action-names

97f1383

cwperks reviewed Jun 13, 2023

View reviewed changes

server/src/main/java/org/opensearch/rest/NamedRoute.java Outdated Show resolved Hide resolved

Fixes test failures

6e10d89

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

DarshitChanpura requested a review from dbwiddis July 5, 2023 16:01

DarshitChanpura mentioned this pull request Jul 5, 2023

[FEATURE] Make NamedRoute a Writeable opensearch-project/opensearch-sdk-java#858

Open

Makes build fail one not setting builder fields

cb9ad3d

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

DarshitChanpura added v2.9.0 'Issues and PRs related to version v2.9.0' backport PRs or issues specific to backporting features or enhancments backport 2.x Backport to 2.x branch labels Jul 5, 2023

dbwiddis reviewed Jul 5, 2023

View reviewed changes

server/src/main/java/org/opensearch/action/ActionModule.java Outdated Show resolved Hide resolved

server/src/main/java/org/opensearch/rest/NamedRoute.java Outdated Show resolved Hide resolved

Addresses PR feedback

aac062a

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

dbwiddis approved these changes Jul 5, 2023

View reviewed changes

peternied merged commit 50d8006 into opensearch-project:main Jul 5, 2023

DarshitChanpura mentioned this pull request Jul 5, 2023

[Backport 2.x] Support transport action names when registering NamedRoutes (#7957) #8459

Merged

6 tasks

DarshitChanpura added a commit to DarshitChanpura/OpenSearch that referenced this pull request Jul 11, 2023

Revert "[Backport 2.x] Support transport action names when registerin…

79316a4

…g NamedRoutes (opensearch-project#7957) (opensearch-project#8459)" This reverts commit cd82f4c.

DarshitChanpura mentioned this pull request Jul 12, 2023

[Research] [BUG] Extension requests show "false" timeout for first few requests to extension due to unknown bug #8652

Closed

DarshitChanpura added a commit to DarshitChanpura/OpenSearch that referenced this pull request Jul 12, 2023

Revert "[Backport 2.x] Support transport action names when registerin…

ebf3ebc

…g NamedRoutes (opensearch-project#7957) (opensearch-project#8459)" This reverts commit cd82f4c.

nknize pushed a commit that referenced this pull request Jul 12, 2023

Revert "[Backport 2.x] Support transport action names when registerin…

4890548

…g NamedRoutes (#7957) (#8459)" (#8651) This reverts commit cd82f4c. Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

DarshitChanpura mentioned this pull request Jul 13, 2023

Map extension routes to permission-able action names opensearch-project/security#2589

Closed

Conversation

DarshitChanpura commented Jun 7, 2023 • edited by peternied Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Check List

Uh oh!

cwperks left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 7, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

Uh oh!

github-actions bot commented Jun 7, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented Jun 7, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented Jun 7, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented Jun 7, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented Jun 8, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented Jun 8, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 13, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented Jul 5, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented Jul 5, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

dbwiddis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dbwiddis left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jul 5, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

DarshitChanpura commented Jul 5, 2023

Uh oh!

opensearch-trigger-bot bot commented Jul 5, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

DarshitChanpura commented Jun 7, 2023 •

edited by peternied

Loading